add code action quick-fix to add `@override` #1680

NCBM · 2025-12-17T13:59:26Z

DetachHead · 2025-12-20T20:08:23Z

to get auto imports working, you can probably use the same method i used for completions

basedpyright/packages/pyright-internal/src/languageService/completionProvider.ts

Lines 559 to 575 in 0b0e727

    
           const importTextEditInfo = this.createAutoImporter( 
        
               completionMap, 
        
               this.options.lazyEdit 
        
           ).getTextEditsForAutoImportByFilePath( 
        
               { name: 'override' }, 
        
               { name: overrideDecorator.shared.moduleName }, 
        
               'override', 
        
               ImportGroup.BuiltIn, 
        
               overrideDecorator.shared.declaration!.uri 
        
           ); 
        
           if (importTextEditInfo.edits) { 
        
               additionalTextEdits.push(...importTextEditInfo.edits); 
        
           } 
        
           additionalTextEdits.push({ 
        
               range: { start: position, end: position }, 
        
               replacementText: `@${importTextEditInfo.insertionText}\n${indent}`, 
        
           });

NCBM · 2025-12-21T11:59:15Z

to get auto imports working, you can probably use the same method i used for completions

The AutoImporter does import, however I firstly tried and found that it still does import even when the symbol is already imported - this causes duplicate imports.

Using CompletionProvider is also currently not possible - it can only process the symbol already been in the document.

I'm not sure either duplicate import or letting users do double-fix would be better, or there are better solutions?

DetachHead · 2025-12-25T07:18:23Z

i was able to get it working. i just pushed my changes. needs to be cleaned up a bit though (mainly the duplicated code)

DetachHead

thanks for the contribution

packages/pyright-internal/src/languageService/codeActionProvider.ts

NCBM · 2025-12-27T06:19:49Z

looks like some execution order randomly incorrect (check before parse) on this macos test. maybe related to a new issue or some hard-to-reproduce issues.

basedpyright/packages/pyright-internal/src/analyzer/program.ts

Lines 2023 to 2082 in 6c2a199

    
           private _checkTypes( 
        
               fileToCheck: SourceFileInfo, 
        
               options?: { chainedByList?: SourceFileInfo[]; skipFileNeededCheck?: boolean } 
        
           ) { 
        
               // For very large programs, we may need to discard the evaluator and 
        
               // its cached types to avoid running out of heap space. 
        
               this._handleMemoryHighUsage(); 
        
               return this._logTracker.log(`analyzing: ${fileToCheck.uri}`, (logState) => { 
        
                   // If the file isn't needed because it was eliminated from the 
        
                   // transitive closure or deleted, skip the file rather than wasting 
        
                   // time on it. 
        
                   if (!this._isFileNeeded(fileToCheck)) { 
        
                       logState.suppress(); 
        
                       return false; 
        
                   } 
        
                   if (!fileToCheck.sourceFile.isCheckingRequired()) { 
        
                       logState.suppress(); 
        
                       return false; 
        
                   } 
        
                   if (!options?.skipFileNeededCheck && !this._shouldCheckFile(fileToCheck)) { 
        
                       logState.suppress(); 
        
                       return false; 
        
                   } 
        
                   // Bind the file if necessary even if we're not going to run the checker. 
        
                   // disableChecker means disable semantic errors, not syntax errors. We need to bind again 
        
                   // in order to generate syntax errors. 
        
                   const boundFile = this._bindFile( 
        
                       fileToCheck, 
        
                       undefined, 
        
                       // If binding is required we want to make sure to bind the file, otherwise 
        
                       // the sourceFile.check below will fail. 
        
                       /* skipFileNeededCheck */ fileToCheck.sourceFile.isBindingRequired() 
        
                   ); 
        
                   if (!this._disableChecker) { 
        
                       // For ipython, make sure we check all its dependent files first since 
        
                       // their results can affect this file's result. 
        
                       const dependentFiles = this._checkDependentFiles(fileToCheck, options?.chainedByList); 
        
                       if (this._preCheckCallback) { 
        
                           const parseResults = fileToCheck.sourceFile.getParserOutput(); 
        
                           if (parseResults) { 
        
                               this._preCheckCallback(parseResults, this._evaluator!); 
        
                           } 
        
                       } 
        
                       if (boundFile) { 
        
                           fileToCheck.sourceFile.check( 
        
                               this.configOptions, 
        
                               this._lookUpImport, 
        
                               this._importResolver, 
        
                               this._evaluator!, 
        
                               dependentFiles 
        
                           ); 
        
                       } 
        
                   }

github-actions · 2025-12-27T06:37:39Z

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

DetachHead · 2025-12-27T20:06:28Z

yeah i've seen that failure before, no idea what causes it but re-running the job usually fixes it. i'll open a separate issue to investigate

add code action to add @override

04844d6